版本：V3.0

家庭管理API

獲取家庭列表

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object	Body	是	命令參數

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	[]Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
account_id	String	Body	賬號ID
residence_id	String	Body	住宅ID
family_name	String	Body	家庭名稱
online	Boolean	Body	判斷家庭在離線狀態 true：在線 false：離線
installed	Boolean	Body	判斷家庭安裝狀態 true：安裝完成 false：未安裝完成

請求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_family_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {}
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "account_id": "ar58fa9ac8b6a2401bba0828fab548850",
      "residence_id": "r8b5a73f8dd84abaa94dcs248be49b0db",
      "family_name": "my home",
      "online": true,
      "installed": true
    }
  ]
}

失敗返回示例

見接口失敗返回

獲取家庭信息

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
residence_id	String	Body	是	住宅ID

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
family_name	String	Body	家庭名稱
online	Boolean	Body	判斷家庭在離線狀態 true：在線 false：離線
installed	Boolean	Body	判斷家庭安裝狀態 true：安裝完成 false：未安裝完成
accounts	[]Object<account>	Body	賬號信息

account說明

參數名	類型	位置	說明
account_id	String	Body	賬號ID
account_name	String	Body	賬號名稱
first_name	String	Body	名
last_name	String	Body	姓
email	String	Body	郵箱
auth	String	Body	賬號權限 admin：擁有者，最高管理員 user：家庭管理員用戶 guest：家庭普通用戶

請求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_family_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "family_name": "my home",
    "online": true,
    "installed": true,
    "accounts": [
      {
        "account_id": "ar58fa9ac8b6a2401bba0828fab548850",
        "account_name": "demo@akubela.com",
        "first_name": "tom",
        "last_name": "fly",
        "email": "demo@akubela.com",
        "auth": "user"
      }
    ]
  }
}

失敗返回示例

見接口失敗返回

更新家庭信息

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
residence_id	String	Body	是	住宅ID
family_name	String	Body	是	家庭名稱

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_family_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
    "family_name": "my home"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

更換家庭主賬號

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
residence_id	String	Body	是	住宅ID
account_id	String	Body	是	賬號ID

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "change_family_admin",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
    "account_id": "ar31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

邀請家庭賬號

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
residence_id	String	Body	是	住宅ID
email	String	Body	是	郵箱
auth	String	Body	是	賬號權限 user：家庭管理員用戶 guest：家庭普通用戶

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "invite_family_account",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
    "email": "demo@akubela.com",
    "auth": "user"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

賬號加入家庭

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
residence_id	String	Body	是	住宅ID
auth	String	Body	是	賬號權限 user：家庭管理員用戶 guest：家庭普通用戶

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "account_join_family",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
    "auth": "user"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

創建家庭賬號

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
residence_id	String	Body	是	住宅ID
password	String	Body	否	密碼
first_name	String	Body	是	名
last_name	String	Body	是	姓
email	String	Body	是	郵箱
auth	String	Body	是	賬號權限 user：家庭管理員用戶 guest：家庭普通用戶

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
account_id	String	Body	賬號ID

請求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_family_account",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
    "auth": "guest",
    "first_name": "tom",
    "last_name": "fly",
    "email": "demo@akubela.com"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "account_id": "ar58fa9ac8b6a2401bba0828fab548850"
  }
}

失敗返回示例

見接口失敗返回

更新家庭賬號權限

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
account_id	String	Body	是	賬號ID
residence_id	String	Body	是	住宅ID
auth	String	Body	是	賬號權限 user：家庭管理員用戶 guest：家庭普通用戶

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_family_account_auth",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "account_id": "ar58fa9ac8b6a2401bba0828fab548850",
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
    "auth": "guest"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

批量更新家庭賬號權限

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
residence_id	String	Body	是	住宅ID
accounts	[]Object<account>	Body	是	賬號信息

account說明

參數名	類型	位置	必填	說明
account_id	String	Body	是	賬號ID
auth	String	Body	是	賬號權限 user：家庭管理員用戶 guest：家庭普通用戶

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "batch_update_family_account_auth",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
    "accounts": [
      {
        "account_id": "ar58fa9ac8b6a2401bba0828fab548850",
        "auth": "guest"
      }
    ]
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

刪除家庭賬號

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
account_id	String	Body	是	賬號ID
residence_id	String	Body	是	住宅ID

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_family_account",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "account_id": "ar58fa9ac8b6a2401bba0828fab548850",
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

批量刪除家庭賬號

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
residence_id	String	Body	是	住宅ID
accounts	[]Object<account>	Body	是	賬號信息

account說明

參數名	類型	位置	必填	說明
account_id	String	Body	是	賬號ID

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "batch_delete_family_account",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
    "accounts": [
      {
        "account_id": "ar58fa9ac8b6a2401bba0828fab548850"
      }
    ]
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

獲取家庭遠程連接

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
residence_id	String	Body	是	住宅ID

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
remote_connect_url	String	Body	遠程連接地址
online	Boolean	Body	判斷家庭在離線狀態 true：在線 false：離線

請求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_family_remote_connect",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r2c4b070cc928496198944858b344fc68"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724721898925,
  "result": {
    "remote_connect_url": "https://test.my.ecloud.akubela.com",
    "online": true
  }
}

失敗返回示例

見接口失敗返回

獲取家庭列表​

接口地址​

請求參數​

返回參數​

result說明​

請求示例​

成功返回示例​

失敗返回示例​

獲取家庭信息​

接口地址​

請求參數​

param說明​

返回參數​

result說明​

account說明​

請求示例​

成功返回示例​

失敗返回示例​

更新家庭信息​

接口地址​

請求參數​

param說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

更換家庭主賬號​

接口地址​

請求參數​

param說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

邀請家庭賬號​

接口地址​

請求參數​

param說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

賬號加入家庭​

接口地址​

請求參數​

param說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

創建家庭賬號​

接口地址​

請求參數​

param說明​

返回參數​

result說明​

請求示例​

成功返回示例​

失敗返回示例​

更新家庭賬號權限​

接口地址​

請求參數​

param說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

批量更新家庭賬號權限​

接口地址​

請求參數​

param說明​

account說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

刪除家庭賬號​

接口地址​

請求參數​

param說明​

獲取家庭列表

接口地址

請求參數

返回參數

result說明

請求示例

成功返回示例

失敗返回示例

獲取家庭信息

接口地址

請求參數

param說明

返回參數

result說明

account說明

請求示例

成功返回示例

失敗返回示例

更新家庭信息

接口地址

請求參數

param說明

返回參數

請求示例

成功返回示例

失敗返回示例

更換家庭主賬號

接口地址

請求參數

param說明

返回參數

請求示例

成功返回示例

失敗返回示例

邀請家庭賬號

接口地址

請求參數

param說明

返回參數

請求示例

成功返回示例

失敗返回示例

賬號加入家庭

接口地址

請求參數

param說明

返回參數

請求示例

成功返回示例

失敗返回示例

創建家庭賬號

接口地址

請求參數

param說明

返回參數

result說明

請求示例

成功返回示例

失敗返回示例

更新家庭賬號權限

接口地址

請求參數

param說明

返回參數

請求示例

成功返回示例

失敗返回示例

批量更新家庭賬號權限

接口地址

請求參數

param說明

account說明

返回參數

請求示例

成功返回示例

失敗返回示例

刪除家庭賬號

接口地址

請求參數

param說明